<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Wally The Sentry Bot: MegaMan/MegaMan.h Source File</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">Wally The Sentry Bot
   &#160;<span id="projectnumber">0.2</span>
   </div>
   <div id="projectbrief">A silly Arduino project to play with sensors, Xbees and a Peggy 2.0 pegboard</div>
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('_mega_man_8h.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">MegaMan/MegaMan.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="_mega_man_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 
<a name="l00002"></a>00002 
<a name="l00003"></a>00003 
<a name="l00004"></a>00004 <span class="preprocessor">#ifndef __MegaMan_h__</span>
<a name="l00005"></a>00005 <span class="preprocessor"></span><span class="preprocessor">#define __MegaMan_h__</span>
<a name="l00006"></a>00006 <span class="preprocessor"></span>
<a name="l00008"></a>00008 <span class="comment">// Macro definitions</span>
<a name="l00009"></a>00009 <span class="comment">// Bit shift magic</span>
<a name="l00010"></a><a class="code" href="group___mega_man.html#ga88866375a97efd9911514c81c87d5929">00010</a> <span class="preprocessor">#define getRightN(pixelByte) (pixelByte &amp; 0x0F)     ///&lt; Get the right 4bit nibble from  pixelByte</span>
<a name="l00011"></a><a class="code" href="group___mega_man.html#ga9d44d6425f8227b6cbefb103eb8a3fa5">00011</a> <span class="preprocessor"></span><span class="preprocessor">#define getLeftN(pixelByte) (pixelByte &gt;&gt; 4 &amp; 0x0F) ///&lt; Get the left 4bit nibble from pixelByte</span>
<a name="l00012"></a>00012 <span class="preprocessor"></span>
<a name="l00013"></a><a class="code" href="group___mega_man.html#gab304dddbd1678551085bc66d54776d90">00013</a> <span class="preprocessor">#define setRightN(buffer,pixelByte) buffer = (buffer &amp; 0xF0 | (pixelByte &amp; 0x0F))       ///&lt; Set right 4bit nibble of buffer with content of pixelByte</span>
<a name="l00014"></a><a class="code" href="group___mega_man.html#ga7417764fac912650a002010fbb4d02d7">00014</a> <span class="preprocessor"></span><span class="preprocessor">#define setLeftN(buffer,pixelByte) buffer = (buffer &amp; 0x0F| (pixelByte &lt;&lt; 4 &amp; 0xF0))    ///&lt; Set left 4bit nibble of buffer with content of pixelByte</span>
<a name="l00015"></a>00015 <span class="preprocessor"></span>  
<a name="l00016"></a><a class="code" href="group___mega_man.html#ga23569b6fb24ec4bd1583b2ee506df91b">00016</a> <span class="preprocessor">#define joinNibbles(pixelByte,lsbPixel,msbPixel) pixelByte = (lsbPixel &amp; 0x0F| msbPixel &lt;&lt; 4 &amp; 0xF0)    ///&lt; Join two 4bit nibbles (lsbPixel and msbPixel) into a single byte (pixelByte)</span>
<a name="l00017"></a>00017 <span class="preprocessor"></span>
<a name="l00018"></a>00018 <span class="comment">/* a=register, b=bit number to act upon */</span>
<a name="l00019"></a><a class="code" href="group___mega_man.html#gade3c083fa7b1178fcca5671e1830f2f9">00019</a> <span class="preprocessor">#define BIT_SET(a,b) ((a) |= (1&lt;&lt;(b)))      ///&lt; Set bit number b of register/byte/variable a</span>
<a name="l00020"></a><a class="code" href="group___mega_man.html#ga77fc3a931d1ad5fa08201e5c544817a0">00020</a> <span class="preprocessor"></span><span class="preprocessor">#define BIT_CLEAR(a,b) ((a) &amp;= ~(1&lt;&lt;(b)))   ///&lt; Clear bit number b of register/byte/variable a</span>
<a name="l00021"></a><a class="code" href="group___mega_man.html#gab6e0e32ff769c3cf2953456593e5663e">00021</a> <span class="preprocessor"></span><span class="preprocessor">#define BIT_FLIP(a,b) ((a) ^= (1&lt;&lt;(b)))     ///&lt; Flip bit number b of register/byte/variable a</span>
<a name="l00022"></a><a class="code" href="group___mega_man.html#gab53403b709717305a8d0a8e692a70de6">00022</a> <span class="preprocessor"></span><span class="preprocessor">#define BIT_CHECK(a,b) ((a) &amp; (1&lt;&lt;(b)))     ///&lt; Check if bit number b of register/byte/variable is set</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span>
<a name="l00024"></a>00024 <span class="comment">/* x=target variable, y=mask */</span>
<a name="l00025"></a><a class="code" href="group___mega_man.html#ga2b7116275ff2309adc0f8a5b5a249039">00025</a> <span class="preprocessor">#define BITMASK_SET(x,y) ((x) |= (y))       ///&lt; Set bitmask y on variable x</span>
<a name="l00026"></a><a class="code" href="group___mega_man.html#ga1c1eeb80a540f03a0fdcd5a58bc40bf2">00026</a> <span class="preprocessor"></span><span class="preprocessor">#define BITMASK_CLEAR(x,y) ((x) &amp;= (~(y)))  ///&lt; Clear bitmask y on variable x</span>
<a name="l00027"></a><a class="code" href="group___mega_man.html#gaf855e6d4c97dd8def12b1b736ad9c93f">00027</a> <span class="preprocessor"></span><span class="preprocessor">#define BITMASK_FLIP(x,y) ((x) ^= (y))      ///&lt; Flip bitmask y onto variable x</span>
<a name="l00028"></a><a class="code" href="group___mega_man.html#ga1ce97811962c682fbb08a857efd22d67">00028</a> <span class="preprocessor"></span><span class="preprocessor">#define BITMASK_CHECK(x,y) ((x) &amp; (y))      ///&lt; Check for bitmask y on variable x</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span>
<a name="l00030"></a>00030 
<a name="l00031"></a>00031 <span class="comment">// Externally available functions</span>
<a name="l00032"></a>00032 <span class="keywordtype">void</span> <a class="code" href="group___mega_man.html#gad3481dd6138035714f76dc5e63d4f313" title="Copies an image from flash to Peggy.">imageFromFlash</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *);           
<a name="l00033"></a>00033 <span class="keywordtype">void</span> <a class="code" href="group___mega_man.html#gac6a31f9107dfe32d9d1683cf733864c4" title="Updates Peggy - by sending custom made headers. All processing takes place on Peggy.">updatePeggyDisplay</a>(<span class="keywordtype">char</span> *);        
<a name="l00034"></a>00034 <span class="keywordtype">void</span> <a class="code" href="group___mega_man.html#ga103f160680926ae94837d236f4f1ca8a" title="Change the frameBuffer - typically to create graphical effects.">alterBuffer</a>(<span class="keywordtype">char</span> *, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *);      
<a name="l00035"></a>00035 <span class="keywordtype">void</span> <a class="code" href="group___mega_man.html#ga64b15cf19ae6a81a307e4b9163b1f717" title="Transmit the frameBuffer to Peggy.">sendBuffer</a>(uint8_t *);         
<a name="l00036"></a>00036 <span class="keywordtype">void</span> <a class="code" href="group___mega_man.html#ga2d106db4253178eb0b86bb1f83826fdc" title="Display single pixel on Peggy through slow method of transferring entire frameBuffer.">putPixel</a>(uint8_t, uint8_t, uint8_t);   
<a name="l00037"></a>00037 
<a name="l00038"></a>00038 <span class="keyword">extern</span> <span class="keywordtype">boolean</span> <a class="code" href="group___peggy.html#ga120ae5a5f31b7548479805f557e09d17" title="Flag to abort execution if external event demands it.">abortFlag</a>;           
<a name="l00039"></a>00039 
<a name="l00040"></a>00040 <span class="preprocessor">#endif </span><span class="comment">/* __MegaMan_h__ */</span>
<a name="l00041"></a>00041 
</pre></div></div><!-- contents -->
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="_mega_man_8h.html">MegaMan.h</a>      </li>

    <li class="footer">Generated on Thu May 24 2012 00:05:01 for Wally The Sentry Bot by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.6.1 </li>
   </ul>
 </div>


</body>
</html>
